/**
 * (C) Copyright IBM Corp. 2018, 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

import Foundation

/**
 EntityMention.
 */
public struct EntityMention: Codable, Equatable {

    /**
     Entity mention text.
     */
    public var text: String?

    /**
     Character offsets indicating the beginning and end of the mention in the analyzed text.
     */
    public var location: [Int]?

    /**
     Confidence in the entity identification from 0 to 1. Higher values indicate higher confidence. In standard entities
     requests, confidence is returned only for English text. All entities requests that use custom models return the
     confidence score.
     */
    public var confidence: Double?

    // Map each property name to the key that shall be used for encoding/decoding.
    private enum CodingKeys: String, CodingKey {
        case text = "text"
        case location = "location"
        case confidence = "confidence"
    }

}
